This folder contains the Guide Script source files (in Microsoft Word) used to create the example guide files included in this kit. Each separate folder contains the set of source files used to create a single guide file. Study these source files for examples of how to use the Guide Script command language.
IMPORTANT Do not write a mixin file for Macintosh Guide or for any other guide file provided by Apple Computer with its products. Because mixin files must be coded to specific items in the main file, your mixin could disrupt the content of the main file and of other mixins.
For a simple example, start with the About Apple Guide folder. All the necessary Guide Script commands are contained in a single file named “Main.”
As you gain proficiency, browse through the more complex examples such as Macintosh Guide. The Guide Script source files for Macintosh Guide are subdivided and arranged into the following sets.
• Main: a build file that lists all of the other files in the set.
• Globals: Access window and Help menu specifications.
• Topics, Index, and Look For: commands that specify how sequences are presented in the Access window's Topics, Index, and Look For screens.
• Panels: the panels containing the step-by-step instructions.
• Definitions: the panels containing definitions and other brief explanations.
• Oops: the panels containing the Oops (remediation) instructions.
• Coaches: the coach mark definitions.
• Prompts: the prompt set defintions.
• StdIncludes: the standard set of button, event, and context check definitions.
As you review these example files, try to keep these things to keep in mind:
• Authoring guide files is completely scalable. Guide Maker allows you to create very simple guide files and very complex ones—you have complete control over the level of features you want to support in your guide file.
• Jumping into the Macintosh Guide file can be intimidating, even for expert Guide Script users. Don’t be discouraged if some parts of this complex set of instructions don’t make sense right away. Become familiar with the simpler files (such as About Apple Guide) before you try to include complex branching, context checks, and other features in a guide. The source files for all the more complex guides have been included so you can dive in and explore specific features after you’re proficient at basic scripting.
• The file structure of the example guide files is just one way to do it. Use whatever structure makes the most sense for managing and sharing files within your organization.